home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / reward16.zip / REWARD16.DOC < prev    next >
Text File  |  1991-11-15  |  14KB  |  366 lines
  1.  
  2.  
  3.  
  4.  
  5.                                 PCB-REWARD 
  6.                                Documentation
  7.                               
  8.                                 Version 1.6
  9.                                  11-16-91
  10.  
  11.                                Copyright 1991
  12.  
  13.                                 Tom Gregory
  14.                                
  15.  
  16.  
  17.                              All Rights Reserved
  18.                            
  19.  
  20. PCB-REWARD --- What is it?
  21.  
  22. PCB-REWARD is a PCBoard version 14.5 utility to allow the SYSOP to
  23. reward the top uploaders with extra time and/or download bytes.
  24.  
  25. PCB-REWARD runs in your nightly event.  It scans your users file
  26. and selects the top uploaders for the reward.  It then changes
  27. their security level to one that you have selected for them.  It
  28. also writes a bulletin and/or news file which announces who these
  29. top people are and prods others to compete for the slots.
  30.  
  31. With this latest release, PCB-REWARD is NOW FULLY FUNCTIONAL and is
  32. not crippled in any way.  If you elect to have the bulletin and/or
  33. news file generated, a line will be appended to the end of them
  34. which states that it is an evaluation copy.  Once registered, this
  35. line will not appear.
  36.  
  37. You may now select the number of rewards to issue, up to a maximum
  38. of 99. 
  39.  
  40.  
  41. *****************  WARNING TO PREVIOUS VERSION USERS  *************
  42.  
  43. This version uses a totally different routine to scan and reward
  44. the users.  It is IMPERATIVE that you run your old version using
  45. the /NEW switch prior to running this version!  If you do not, it
  46. will corrupt your users file!!!!
  47.  
  48. Run as:   REWARDxx REWARD.CFG /NEW
  49.                 x = version number prior to 1.5
  50.                 Be sure to use your normal .CFG file name
  51.  
  52. *******************************************************************
  53.  
  54.  
  55. HOW TO USE
  56.  
  57. NOTE:  ALL NODES SHOULD BE DOWN BEFORE RUNNING THIS UTILITY.  
  58. ------------------------------------------------------------
  59.  
  60. PCB-REWARD is simple to use.  In your EVENT.SYS file, place a line
  61. that says:
  62.  
  63.     REWARDxx REWARD.CFG    (xx = version number)
  64.     
  65. This will update your top uploader(s) every night.  If a user falls
  66. out of one of the slots, their security level is returned what they
  67. had before the reward.  
  68.  
  69. The REWARD.CFG is a fairly standard configuration file.  I have
  70. included a file called SAMPLE.CFG and a file called REWARD.CFG. 
  71. SAMPLE.CFG is the same as REWARD.CFG, except it is commented.
  72.  
  73. Simply make the changes to REWARD.CFG that conform to your BBS
  74. structure and your option selections.  A word of caution.  The data
  75. in the .CFG file MUST  be in the exact order as presented.  You may
  76. rename the .CFG file, but be sure that you change the command line
  77. in your EVENT.SYS to call the correct .CFG  file at execution time.
  78.  
  79. You may also run this program from the DOS prompt by simply typing
  80. in the command line as it appears in the EVENT.SYS file.  
  81.  
  82. CONFIGURATION FILE
  83.  
  84. Here is the .CFG file format:
  85.  
  86. Software Heaven BBS  ;Name of your BBS or Registered name
  87. 00000                ;Registration Num (00000 if unregistered
  88. c:\pcb\main\users    ;Complete path to users file
  89. 90                   ;Maximum Security to include in scan. 
  90. 5                    ;Number of rewards to issue. Max number is 99
  91. 75                   ;Security level to give Top Uploader
  92. 65                   ;Security level to give remaining Uploaders
  93. c:\pcb\gen\blt5      ;Complete path for Bulletin
  94. c:\pcb\gen\news      ;Complete path for News file
  95. y                    ;Vanity Flag - Set to Y or N  
  96. 3                    ;Bulletin/News creation flag  
  97. y                    ;Future use - must include
  98. 5                    ;Future use - must include
  99.  
  100.  
  101. See SAMPLE.CFG for a complete description of each of these lines.
  102.  
  103.  
  104. SETUP
  105.  
  106. Once you have set up the .CFG file, copy the following files to a
  107. subdirectory or into your main PCB subdirectory.  If you place them
  108. in their own subdirectory, be sure to path to it in your EVENT.SYS
  109. file.
  110.  
  111.  
  112. Files to copy are:
  113.  
  114.           REWARD##.EXE
  115.           REWARD.USR
  116.           REWARD.CFG
  117.           REWBULT.TXT
  118.  
  119. If you wish to use the user specific menus to tell the rewarded
  120. users that they have been rewarded, copy the BRDMxx files to the
  121. same directory as the rest of your BRDM files.
  122.           
  123. Next, you must make entries in your PWRD file to reflect the
  124. rewarded security levels.  In our example, we used 75 for the top
  125. uploader and 65 for the other users.  If we wanted to give our top
  126. uploader 120 minutes per day and unlimited downloads, we would
  127. enter these figures into the PWRD file. PCB-REWARD will then change
  128. the top user's security level to 75.  Do the same for the other
  129. users.  The amount on privilege that you award is strictly up to
  130. you.  
  131.  
  132. That's all there is to it.
  133.  
  134.  
  135. SWITCHES
  136.  
  137. There is only one(1) switch available in PCB-REWARD.  That is the
  138. /NEW switch.  Case is unimportant.  This switch causes the program
  139. to set the  USERS file back to a non-rewarded status.  All rewarded
  140. users are set back to their original security levels and no new
  141. users are rewarded.  You may want to use this switch to start over
  142. from scratch. 
  143.  
  144. NOTE: I recommend that you use this switch when upgrading from one 
  145. version to another, and then re-run PCB-REWARD as normal.
  146.  
  147. The syntax is as follows:
  148.  
  149.      REWARDxx REWARD.CFG /NEW
  150.       MENUS
  151.  
  152. You may want to create special security specific menus for the
  153. users. I have included main menus for the 2 levels that are shown
  154. in the .CFG file.  You may either change them from BRDMxx to
  155. whatever level you are awarding, create your own, or not use them
  156. at all.
  157.  
  158.  
  159. BULLETINS
  160.  
  161. The included file, REWBULT.TXT, is a sysop definable bulletin file.
  162. This name is hard-coded into the software.  It is the actual file
  163. that the program calls up to make the bulletin.  You may change it
  164. to whatever 'look' that you want.  It may be written using any
  165. drawing utility or editor and uses the " @X## " codes that PCB 14.5
  166. supports. 
  167.  
  168. *** NOTE TO PREVIOUS VERSION USERS ***
  169.  
  170. This version has changed the character used to identify where the
  171. user's names should be placed.  Previous versions used a # sign. 
  172. We now use the tilde mark ~.  Be sure to change your Rewbult.txt
  173. file to reflect this change.  This change was made to allow you to
  174. use the # sign with your descriptor titles.  Also, Be sure to put a
  175. BACKARDS APOSTROPHE  ` in as the last character in the REWBULT.TXT file.
  176. This is a MUST !  See explaination later in this section.
  177.  
  178. *******************************
  179.  
  180. The following format is used to imbed the users names in. 
  181.  
  182.      ~1 = Top Uploader   ~2 - ~99 are the other uploaders.  
  183.  
  184. Just place the tilde and number in the spot that you want that
  185. user's name to appear.  Note that there can be NO space between the
  186. tilde and the number.  PCB-REWARD will call this file and
  187. substitute the selected names in place of the tilde/number
  188. combination when it writes the bulletin.  Note that if the Vanity
  189. flag in the .CFG file is set to yes (y), a copyright line will be
  190. added to the bottom of the bulletin.  
  191.  
  192. I would suggest that you experiment with the format of the
  193. REWBULT.TXT file.  It this point, if users numbers are placed in 2
  194. or more columns, the results may be less than satisfactory.  Look
  195. at the example below:
  196.  
  197.     ~2          ~3
  198.     ~4          ~5
  199.  
  200. This will result in the placement of the following example names
  201. as:
  202.  
  203.     Joe Modem          Jim Sysop 
  204.     Susie Computer         Sam Byte
  205.  
  206. I would also suggest either putting each ~x on a separate line or
  207. using a comma and SINGLE space between each name on a line.  
  208.  
  209.       ~2
  210.       ~3
  211.       ~4
  212.  
  213.       OR
  214.  
  215.  ~2, ~3, ~4
  216.  ~5, ~6, ~7
  217.  
  218. The above formats make for a better visual appearance.
  219.  
  220. I am currently working on code to improve this appearance and to
  221. place the names exactly the same distance apart, but have not
  222. finished it yet.  
  223.  
  224. You also MUST have a BACKWARDS APOSTROPHE as the last character in 
  225. the REWBULT.TXT file.  This mark tells the program where the end is and
  226. where the News file will start.  Also, see the discussion on this mark
  227. in the NEWS section below.
  228.  
  229.  
  230. NEWS FILE GENERATION
  231.  
  232. You now have the ability to place the REWBULT.TXT message at the
  233. top of your NEWS file as part of the nightly event.  To enable this
  234. feature, the flag at line 11 of the .CFG file must be set to 2 or
  235. 3.  You must also use a text editor to modify your existing NEWS
  236. file before you use this feature the first time. (Note: you only
  237. have to modify it once).  Simply insert a ` mark as the very first
  238. character of your existing news file.  Note that this mark is the
  239. BACKWARDS APOSTROPHE and NOT the regular apostrophe.  It is usually
  240. located on the same key as the tilde.  If you have separate files
  241. for color and non-graphics modes, be sure to include it in both.  This 
  242. one-time chore is in addition to the ` which you have placed in the 
  243. REWBULT.TXT file.  The only other time you have to add this mark is
  244. when you edit the actual news file.. See below.
  245.  
  246. Once this is done, PCB-REWARD will scan your News file and
  247. disregard everything until it finds the backward apostrophe.  It
  248. will then start saving the info (your original news file) into a
  249. temp file.  It then writes the REWBULT.TXT file to the news file,
  250. inserting the proper users names, and then appends the old news
  251. info back to the new News File.
  252.  
  253. This way, the Reward info gets updated nightly without affecting
  254. your existing news.
  255.  
  256. The only problem that this may cause you, is that you will need to
  257. manually delete the reward portion of the news file before you add
  258. new news.  Be sure to leave the ` mark in the new, modified news
  259. file so that the reward bulletin will be added back on top the next
  260. time PCB-REWARD runs.  
  261.  
  262. If you add news in front of the reward news section, the new
  263. portion will be deleted when the nightly event re-writes it.  This
  264. was not done deliberately, but is simply an effect of the way it
  265. handles the news file merge.
  266.  
  267. I am also working on a feature to allow you to embed the bulletin
  268. any place in the news file, which will correct this problem.
  269.  
  270. REGISTRATION
  271.  
  272. Registration may be accomplished by printing and filling out the
  273. included form, REGISTER.DOC, and mailing it to the address
  274. indicated.  Please enclose  a fee of $10.00.  Make checks payable
  275. to TOM GREGORY.
  276.  
  277. Once I receive these items, I will send you a registration number
  278. which you will need to place in the .CFG file.  This will eliminate
  279. the evaluation message in the bulletins and news files. 
  280.  
  281. BE SURE TO PRINT THE REGISTRATION NAME EXACTLY AS YOU WANT IT TO
  282. APPEAR INT THE .CFG FILE.
  283.  
  284. Registration also entitles you to receive telephone support, as
  285. well as all future updates.  On the registration form, be sure to
  286. include a password for pre-registration on Software Heaven BBS. 
  287. This will allow you to have Visiting Sysop privileges.
  288.  
  289. Registration will also let you sleep better at night !
  290.  
  291.  
  292. If you have questions or problems, you may contact me via the below
  293. method.
  294.  
  295.                
  296.                Tom Gregory
  297.                5278 Tracy Ct.
  298.                Stone Mountain, Ga.  30083
  299.                     
  300.                      or
  301.                          
  302.                 Software Heaven BBS
  303.                 404-413-6579
  304.                
  305.                 Leave a message for me.
  306.                      
  307. ORIGINAL DISTRIBUTION
  308.  
  309. The original distrib contains the following files.  If you pass a
  310. copy of this program to another BBS or another user, please be sure
  311. to include the entire  set.
  312.  
  313.  
  314.           REWARD##.EXE --- The main program
  315.           REWARD.CFG --- Configuration file
  316.           REWARD.USR --- File that stores current top uploaders
  317.           REWARD.DOC --- This manual
  318.           SAMPLE.CFG --- Commented config file
  319.           REWBULT.TXT -- Text file containing the user-definable
  320.                          bulletin
  321.           BLT5       --- Sample Bulletin created by program
  322.           BRDMxxx    --- Sample main board security specific menus 
  323.           REGISTER.FRM - Registration Form
  324.           README.NEW --- Latest features
  325.           HISTORY.TXT -- Revision history
  326.                
  327. If the package that you received does not contain these files,
  328. please advise  the SYSOP of the BBS you received it from that the
  329. package is incomplete.
  330.  
  331. I hate the legal mumbo-jumbo stuff, but it's gotta be there, so
  332. here goes..
  333.  
  334.  
  335.                         COPYRIGHT NOTICE AND DISCLAIMER
  336.  
  337. This software is released as Shareware.   It may be copied and
  338. given to other users as long as all of the files contained in the
  339. original distribution are intact.
  340.  
  341. The user is expected to register this software after a reasonable amount of use, when said use determines that this software has
  342. value to the user, or the user will continue to use this software. 
  343. It is generally accepted that a "reasonable amount of use" should
  344. not exceed 30 days.  At the end of this  period, the user shall
  345. either register this software with the author by submitting the
  346. required fee, or the user shall totally discontinue all use of the
  347. software.  The user also agrees that they shall make no attempt to 
  348. disassemble, modify, tamper with or alter the software in any way. 
  349.  
  350.  
  351. The user further agrees that registration shall authorize them for
  352. the use of this software on one (1) computer system only, at any
  353. one time.  Each additional computer system which also contains this
  354. software must have its own registered copy.  
  355.  
  356. The author of this software is providing it on an as-is basis.  
  357. The author has made every effort to assure that this software will
  358. perform as stated. However, no guarantees are made or implied as to
  359. its usability or functionality.  The author is in no way liable for
  360. any damage caused by the use of this software, either directly or
  361. indirectly.  The user agrees to hold the author harmless for any
  362. problems which may be caused by the use of this software on their
  363. computer system.  However, the author will make every effort  to
  364. assist users with problems should they arise.
  365.  
  366.